home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / msdos / grabbers / grabb394 / gredit.doc < prev    next >
Text File  |  1992-02-04  |  17KB  |  361 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                             GREDIT (tm)   Version 4.3A
  7.  
  8.                           ------------------------------
  9.  
  10.                       A display screen editor for use with
  11.                     the GRABBER (tm) screen capture programs
  12.  
  13.  
  14.                                   DOCUMENTATION
  15.                                  January 31, 1992
  16.  
  17.                              Copyright 1991, 1992 by
  18.                                  Gerald A. Monroe
  19.                                All rights reserved.
  20.  
  21.                          CompuServe Mail ID # 72321,1257
  22.  
  23.  
  24.  
  25.  
  26.           YOUR LICENSE TO USE THIS SOFTWARE
  27.           ----------------------------------
  28.  
  29.           GREDIT.EXE and this documentation are copyright 1991, 1992 by
  30.           Gerald A. Monroe.  All rights are reserved except those expressly
  31.           granted here.
  32.  
  33.           The GREDIT program and this documentation file are distributed as
  34.           part of the GRABBER(tm) screen capture package under the terms of a
  35.           shareware license that is fully set forth in the file GRABBER.DOC.
  36.           (GRABBER.DOC is the reference manual for GRABBER.EXE, the main
  37.           program module in the package.)
  38.  
  39.           The shareware license terms in the GRABBER.DOC file are incorporated
  40.           here by reference.  This license permits you to copy and distribute
  41.           the files GREDIT.EXE and GREDIT.DOC (this file) freely, provided
  42.           that:  these files are always distributed together with each other
  43.           and with the GRABBER.EXE and GRABBER.DOC files; none of the files is
  44.           modified in any way; and no fee, premium or donation of any kind
  45.           whatsoever is charged or requested for their distribution except
  46.           as permitted on the terms described in the GRABBER.DOC file.
  47.  
  48.           Continued use of the GREDIT program for more than a 10-day trial
  49.           period requires you to register your use of the software with the
  50.           author.  For more information about the benefits of registration
  51.           and how to go about registering, please refer to the full licensing
  52.           and ordering information in the GRABBER.DOC file.
  53.  
  54.  
  55.  
  56.         GREDIT (tm)   Documentation and Technical Notes             Page 2 of 7
  57.  
  58.  
  59.  
  60.  
  61.  
  62.                                     GREDIT.DOC
  63.  
  64.                                 TABLE OF CONTENTS
  65.                 --------------------------------------------------
  66.  
  67.                  Overview of GREDIT . . . . . . . . . . . . . . 3
  68.                  Hardware & software requirements . . . . . . . 3
  69.                  Starting GREDIT  . . . . . . . . . . . . . . . 3
  70.                  Editing the GRABBER offspring file . . . . . . 4
  71.                  Cursor movement keys . . . . . . . . . . . . . 4
  72.  
  73.                  Help screen, Alt-H . . . . . . . . . . . . . . 5
  74.                  Quit GREDIT, Alt-Q . . . . . . . . . . . . . . 5
  75.                  Save image to .EXE file, Alt-S . . . . . . . . 5
  76.                  Save image to ANSI file, Alt-A . . . . . . . . 5
  77.                  Set colors, Alt-F  . . . . . . . . . . . . . . 5
  78.                  Toggle blink, Alt-L  . . . . . . . . . . . . . 5
  79.                  Border color, Alt-B  . . . . . . . . . . . . . 5
  80.                  Clear screen, Alt-K  . . . . . . . . . . . . . 5
  81.                  Erase line, Alt-E  . . . . . . . . . . . . . . 5
  82.  
  83.                  Wipe screen, Alt-W . . . . . . . . . . . . . . 6
  84.                  Toggle ruler, Alt-R  . . . . . . . . . . . . . 6
  85.                  Set tabs, Alt-T  . . . . . . . . . . . . . . . 6
  86.                  Import text file, Alt-I  . . . . . . . . . . . 6
  87.                  Load new image, Alt-N  . . . . . . . . . . . . 6
  88.                  Copy to clipboard, Alt-C . . . . . . . . . . . 6
  89.                  Cut to clipboard, Alt-X  . . . . . . . . . . . 6
  90.  
  91.                  Paste from clipboard, Alt-P  . . . . . . . . . 7
  92.                  Line-drawing help, Alt-D . . . . . . . . . . . 7
  93.                  Graphics character help, Alt-G . . . . . . . . 7
  94.                  Query colors at cursor, Alt-Y  . . . . . . . . 7
  95.  
  96.                  Turning off GREDIT's beep sounds . . . . . . . 7
  97.  
  98.  
  99.  
  100.         GREDIT (tm)   Documentation and Technical Notes             Page 3 of 7
  101.  
  102.  
  103.  
  104.         WHAT IS GREDIT?
  105.         ----------------
  106.  
  107.         GREDIT(tm) is a utility you can use to modify the screen images which
  108.         are generated by the GRABBER screen capture program.  Throughout this
  109.         document, these screen image files are referred to as GRABBER
  110.         "offspring."  If you are not familiar with GRABBER and how it works,
  111.         please read the program manual GRABBER.DOC before attempting to use
  112.         GREDIT.
  113.  
  114.         Only text images captured with GRABBER may be edited.  GREDIT does
  115.         not support GRABBER's graphic images.
  116.  
  117.  
  118.         REQUIREMENTS
  119.         -------------
  120.  
  121.         GREDIT has the same hardware and software requirements as GRABBER.
  122.         These are:  a) an IBM-PC, XT, AT, PS/2 or 100% IBM-compatible personal
  123.         computer; b) PC-DOS or MS-DOS, Version 3.0 or later; c) at least one
  124.         diskette drive; and c) at least 128Kb free memory.  You will also need
  125.         the program GRABBER.EXE in order to use GREDIT.
  126.  
  127.         You can use GREDIT with either a color or monochrome display.
  128.  
  129.  
  130.         STARTING GREDIT
  131.         ----------------
  132.  
  133.         To start the program, simply type GREDIT at the DOS prompt, optionally
  134.         followed by the name of the GRABBER offspring file you wish to edit,
  135.         then press <RETURN>.  The correct syntax is:
  136.  
  137.                                  GREDIT [filename]
  138.  
  139.         If you omit the filename, the program will ask you to supply one.
  140.  
  141.         GREDIT assumes that the file you wish to edit has the extension ".EXE"
  142.         in its name.  Therefore, you can omit the extension when specifying
  143.         the file to be edited.  For instance, entering "GREDIT SCREEN00" is
  144.         the same as entering "GREDIT SCREEN00.EXE".
  145.  
  146.  
  147.  
  148.         GREDIT (tm)   Documentation and Technical Notes             Page 4 of 7
  149.  
  150.  
  151.  
  152.         EDITING THE OFFSPRING FILE
  153.         ---------------------------
  154.  
  155.         You are now inside GREDIT, with the cursor at the upper left-hand
  156.         corner of the screen.  You may use your keyboard to edit the image
  157.         inside the GRABBER offspring file, including its text content,
  158.         layout and color scheme.  At your disposal are all of the alphanumeric
  159.         and cursor-movement keys, the function keys <F1> through <F10>,
  160.         plus 17 special Alt-key functions which are described below.
  161.  
  162.  
  163.         CURSOR MOVEMENT
  164.         ----------------
  165.  
  166.         GREDIT supports the following keys on your PC keyboard to help you
  167.         move around inside your GRABBER offspring image.  Except for the
  168.         backspace key ( <X] ), none of these keys alters the image on the
  169.         screen; they merely move the editing cursor to the desired location.
  170.  
  171.            [UP ARROW]  . . . . . . cursor up one line
  172.            [DOWN ARROW]  . . . . . cursor down one line
  173.            [LEFT ARROW]  . . . . . cursor one space to the left
  174.            [RIGHT ARROW] . . . . . cursor one space to the right
  175.            [HOME]  . . . . . . . . cursor to upper left corner of display
  176.            [PAGE UP] . . . . . . . cursor to upper right corner of display
  177.            [END] . . . . . . . . . cursor to lower left corner of display
  178.            [PAGE DOWN] . . . . . . cursor to lower right corner of display
  179.            [RETURN]  . . . . . . . cursor to left edge, next line down
  180.            [TAB] . . . . . . . . . cursor right to next tab stop
  181.            [SHIFT-TAB] . . . . . . cursor left to previous tab stop
  182.            [BACKSPACE] . . . . . . cursor one space left, erase char. there
  183.  
  184.         The [INSERT] key deserves a special mention.  This key does not
  185.         allow you to insert characters into a line as you would expect
  186.         using a word processor.  Rather, holding down the [INSERT] key
  187.         while pressing another alphanumeric or function key 1-10 causes
  188.         the editing cursor to advance backward from right to left.  This
  189.         can be helpful when drawing boxes with the <F1-F10> keys.
  190.  
  191.  
  192.  
  193.         GREDIT (tm)   Documentation and Technical Notes             Page 5 of 7
  194.  
  195.  
  196.  
  197.  
  198.         GREDIT ALT-KEY FUNCTIONS
  199.         -------------------------
  200.  
  201.  
  202.  
  203.          KEY                                FUNCTION
  204.         -----        --------------------------------------------------------
  205.  
  206.         Alt-H        Help.  This function pops up a list of all of GREDIT's
  207.                        special Alt-key functions and a brief description of
  208.                        each.  Press any key to resume editing.
  209.  
  210.         Alt-Q        Quit.  This function exits GREDIT, and gives you the
  211.                        option of saving your changes to disk before leaving.
  212.  
  213.         Alt-S        Save.  This function saves your changes to disk without
  214.                        exiting the program.
  215.  
  216.         Alt-A        Save to ANSI file.  This function saves the current image
  217.                        to an ANSI-encoded file.  ANSI files are text files
  218.                        which contain special control codes that preserve all
  219.                        of the colors in the image.  The Alt-A function performs
  220.                        the same task as the separate GR2ANSI(tm) program, a
  221.                        command-line utility which is also included in the
  222.                        GRABBER package.
  223.  
  224.         Alt-F        Colors.  This function lets you change the global color
  225.                        attribute.  To adjust the foreground color, press the
  226.                        up and down arrow keys.  To adjust the background color,
  227.                        press the left and right arrow keys.  To resume editing,
  228.                        press <Esc> or <Return>.  Users with monochrome systems
  229.                        should also read about the Alt-Y function below.
  230.  
  231.         Alt-L        Blink.  This function toggles the "blink" attribute on and
  232.                        off for characters typed at the keyboard.
  233.  
  234.         Alt-B        Border color.  This function lets you adjust the color of
  235.                        the screen border on color systems.  Border color is not
  236.                        available on monochrome systems.
  237.  
  238.         Alt-K        Clear screen.  This function erases the entire display,
  239.                        and fills it with the last color you specified using the
  240.                        Alt-F function.
  241.  
  242.         Alt-E        Erase line.  This function erases the line on which the
  243.                        cursor is currently located.  To avoid accidental
  244.                        erasures, Alt-E must be pressed twice.  The erased line
  245.                        will be filled with the last color you specified using
  246.                        the Alt-F function.
  247.  
  248.  
  249.  
  250.         GREDIT (tm)   Documentation and Technical Notes             Page 6 of 7
  251.  
  252.  
  253.  
  254.         Alt-W        Wipe.  This function lets you change either the foreground
  255.                        or the background color of ALL characters on the screen
  256.                        at once.  After pressing Alt-W, press <F> to wipe the
  257.                        foreground, or <B> to wipe the background, or any
  258.                        other key to cancel.  The foreground or background will
  259.                        be wiped to the last color you specified using the Alt-F
  260.                        function.
  261.  
  262.         Alt-R        Ruler.  This function toggles on and off the ruler display
  263.                        at the top of the screen.  The ruler shows all of the
  264.                        currently defined tab stops.  While the ruler is being
  265.                        displayed, you cannot make changes to the top line of
  266.                        the image.
  267.  
  268.         Alt-T        Tabs.  This function lets you adjust the tab value.  The
  269.                        minimum tab value is always 2.  The maximum value equals
  270.                        the number of character spaces per line, minus one.
  271.  
  272.         Alt-I        Import.  This function allows you to import plain ASCII
  273.                        text files into your image.  Imported files are overlaid
  274.                        onto whatever image already exists on the screen, using
  275.                        the foreground and background colors you specified with
  276.                        the most recent Alt-F function.  GREDIT reads in only
  277.                        as much of the text file as will fit on the screen,
  278.                        starting from the top of the file.
  279.  
  280.         Alt-N        New offspring.  This function lets you load and edit a
  281.                        new GRABBER offspring image.  Alt-N does not remind you
  282.                        to save the current image before loading another, so
  283.                        you may want to invoke Alt-S first.
  284.  
  285.         Alt-C        Copy to clipboard.  This function allows you to specify
  286.                        a rectangular area of the image to copy to GREDIT's
  287.                        off-screen "clipboard" storage area.  First, move the
  288.                        cursor to one of the four corners of the area to be
  289.                        copied, and press Alt-C.  Then, use the arrow keys to
  290.                        move the cursor to the *opposite* corner of the area
  291.                        to be saved, and press <Return>.  To confirm the
  292.                        area selected, press <Return> again, or press <Esc>
  293.                        to cancel.  Please note that GREDIT's clipboard can fit
  294.                        only one item at a time; when you copy something to the
  295.                        clipboard, you erase the clipboard's previous contents.
  296.  
  297.         Alt-X        Cut to clipboard.  This function works exactly like the
  298.                        Alt-C function described above, with one difference.
  299.                        Whatever portion of the image you select will also be
  300.                        erased from the screen after it is moved to the
  301.                        clipboard.
  302.  
  303.  
  304.  
  305.         GREDIT (tm)   Documentation and Technical Notes             Page 7 of 7
  306.  
  307.  
  308.  
  309.         Alt-P        Paste from clipboard.  This function can be used to paste
  310.                        the contents of the clipboard back to the screen.
  311.                        First, move the cursor to the upper-left corner of the
  312.                        area you wish to fill from the clipboard, and press
  313.                        Alt-P.  GREDIT will show you the outlines of the area
  314.                        saved on the clipboard.  To confirm the Paste operation,
  315.                        press <Return>, or press <Esc> to cancel.
  316.  
  317.         Alt-D        Line-drawing help.  This function pops up a list of
  318.                        line- and box-drawing characters, and the function keys
  319.                        (F1 through F10) which are associated with them.  To
  320.                        access these characters in GREDIT, press the function
  321.                        key indicated in the list, either alone or together with
  322.                        the <Shift>, <Ctrl> or <Alt> keys.  Press any key to
  323.                        exit the list and resume editing.
  324.  
  325.         Alt-G        Graphics character help.  This function pops up a table
  326.                        showing all the special graphics characters in the
  327.                        IBM-PC character set.  The numbers at the left and top
  328.                        of the grid are added together to determine the ASCII
  329.                        code of any character in the table.  To access these
  330.                        characters in GREDIT, first hold down the <Alt> key,
  331.                        then type the character's ASCII code on your keyboard's
  332.                        numeric keypad, and then release the <Alt> key.
  333.  
  334.         Alt-Y        Query attribute at cursor.  This function is available on
  335.                        monochrome systems only.  It allows you to determine
  336.                        how a certain character will appear if the offspring
  337.                        screen is later shown on a color display.  Move the
  338.                        cursor to the character you want to check, and press
  339.                        Alt-Y.  The top line of the display will tell you the
  340.                        "foreground-on-background" color scheme for this
  341.                        character if it were shown on a color system.
  342.  
  343.  
  344.         ELIMINATING GREDIT's BEEP SOUNDS
  345.         ---------------------------------
  346.  
  347.         To eliminate the beep sounds which GREDIT normally makes when you
  348.         invoke any of its special Alt-key functions, include the /Q
  349.         command-line switch when you start the program at the DOS prompt.
  350.         For example:
  351.                                 GREDIT /Q
  352.                           or,
  353.                                 GREDIT screenxx /Q
  354.  
  355.         If you omit the /Q switch from the command line and later decide to
  356.         turn off the beep sounds, you must exit the program (don't forget to
  357.         save your work) and restart the program using the /Q switch on the
  358.         command line.
  359.  
  360.                          * * *  End of GREDIT.DOC  * * *
  361.